LanguageExt.Core

LanguageExt.Core Monads State and Environment Monads State State

Contents

Sub modules

Extensions
Operators
Trait

record State <S, A> (Func<S, (A Value, S State)> runState) Source #

State monad transformer, which adds a modifiable state to a given monad.

Parameters

type S

State type

type M

Given monad trait

type A

Bound value type

Properties

property State<S, S> Get Source #

Extracts the state value and returns it as the bound value

Parameters

returns

State

Methods

method State<S, A> Pure (A value) Source #

Lift a pure value into the monad-transformer

Parameters

param value

Value to lift

returns

State

method State<S, Unit> Modify (Func<S, S> f) Source #

Extracts the state value, maps it, and then puts it back into the monadic state.

Parameters

param f

State mapping function

returns

State

method State<S, Unit> Put (S value) Source #

Writes the value into the monadic state

Parameters

returns

State

method State<S, A> Gets (Func<S, A> f) Source #

Extracts the state value and maps it to the bound value

Parameters

param f

State mapping function

returns

State

method State<S, A> GetsM (Func<S, State<S, A>> f) Source #

Extracts the state value and maps it to the bound value

Parameters

param f

State mapping function

returns

State

method State<S, A> Lift (Pure<A> monad) Source #

Lifts a given monad into the transformer

Parameters

param monad

Monad to lift

returns

State

method State<S, A> Lift (Func<A> f) Source #

Lifts a function into the transformer

Parameters

param f

Function to lift

returns

State

method State<S, B> Map <B> (Func<A, B> f) Source #

Maps the bound value

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, B> Select <B> (Func<A, B> f) Source #

Maps the bound value

Parameters

type B

Target bound value type

param f

Mapping transducer

returns

State

method State<S, B> Bind <B> (Func<A, K<State<S>, B>> f) Source #

Monad bind operation

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, B> Bind <B> (Func<A, State<S, B>> f) Source #

Monad bind operation

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, B> Bind <B> (Func<A, Gets<S, B>> f) Source #

Monad bind operation

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, Unit> Bind (Func<A, Put<S>> f) Source #

Monad bind operation

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, Unit> Bind (Func<A, Modify<S>> f) Source #

Monad bind operation

Parameters

type B

Target bound value type

param f

Mapping function

returns

State

method State<S, C> SelectMany <B, C> (Func<A, K<State<S>, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method State<S, C> SelectMany <B, C> (Func<A, State<S, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method State<S, C> SelectMany <B, C> (Func<A, Pure<B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method State<S, C> SelectMany <C> (Func<A, Put<S>> bind, Func<A, Unit, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method State<S, C> SelectMany <B, C> (Func<A, Gets<S, B>> bind, Func<A, B, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method State<S, C> SelectMany <C> (Func<A, Modify<S>> bind, Func<A, Unit, C> project) Source #

Monad bind operation

Parameters

type B

Intermediate bound value type

type C

Target bound value type

param bind

Monadic bind function

param project

Projection function

returns

State

method (A Value, S State) Run (S state) Source #

Run the state monad

Parameters

param state

Initial state

returns

Bound monad

Operators

operator >> (State<S, A> lhs, State<S, A> rhs) Source #

operator >> (State<S, A> lhs, K<State<S>, A> rhs) Source #

operator >> (State<S, A> lhs, State<S, Unit> rhs) Source #

Sequentially compose two actions. The second action is a unit returning action, so the result of the first action is propagated.

Parameters

param lhs

First action to run

param rhs

Second action to run

returns

Result of the first action

operator >> (State<S, A> lhs, K<State<S>, Unit> rhs) Source #

Sequentially compose two actions. The second action is a unit returning action, so the result of the first action is propagated.

Parameters

param lhs

First action to run

param rhs

Second action to run

returns

Result of the first action

class State <S> Source #

Methods

method State<S, A> pure <A> (A value) Source #

class State Source #

Methods

method State<S, A> pure <S, A> (A value) Source #

method State<S, S> get <S> () Source #

method State<S, A> gets <S, A> (Func<S, A> f) Source #

method State<S, A> getsM <S, A> (Func<S, State<S, A>> f) Source #

method State<S, Unit> put <S> (S state) Source #

method State<S, Unit> modify <S> (Func<S, S> f) Source #